<html>
   <head>
      <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
   
      <link rel="stylesheet" href="./../helpwin.css">
      <title>MATLAB File Help: prtRvGmm</title>
   </head>
   <body>
      <!--Single-page help-->
      <table border="0" cellspacing="0" width="100%">
         <tr class="subheader">
            <td class="headertitle">MATLAB File Help: prtRvGmm</td>
            
            
         </tr>
      </table>
      <div class="title">prtRvGmm</div>
      <div class="helptext"><pre><!--helptext -->  <span class="helptopic">prtRvGmm</span> - Gaussian Mixture Model Random Variable
 
    RV = <span class="helptopic">prtRvGmm</span> creates a <span class="helptopic">prtRvGmm</span> object with empty
    mixingProportions and prtRvMvn components. These parameters can be
    set manually or by calling the MLE method. A <span class="helptopic">prtRvGmm</span> is a mixture
    of multi-variance normal random variables.
 
    RV = <span class="helptopic">prtRvGmm</span>(PROPERTY1, VALUE1,...) creates a <span class="helptopic">prtRvGmm</span>
    object RV with properties as specified by PROPERTY/VALUE pairs.
 
    A <span class="helptopic">prtRvGmm</span> object inherits all properties from the prtRv class.
    In addition, it has the following properties:
 
    nComponents         - A positive integer specifiying the number of
                          MVN components in the mixture.
    covarianceStructure - The covariance structure applied to each of
                          the prtRvMvn objects in the mixture. See prtRvMvn.
    covariancePool      - A logical specifying whether the components
                          should share a common covariance. If set to
                          true the covariance of the components are 
                          set to the weighted average of the maximum
                          likelihood estimate for the covariance 
                          matrices for the components.
    components          - An array of prtRvMvn objects.
    mixingProportions   - A discrete probability vector, representing
                          the probability of each component in the
                          mixture.
 
   A <span class="helptopic">prtRvGmm</span> object inherits all methods from the prtRv class.
   The MLE method can be used to estimate the distribution parameters
   from data.
 
   Examples:
        ds = prtDataGenOldFaithful;      % Load a data set
        rv = <span class="helptopic">prtRvGmm</span>('nComponents',2);  % Specify 2 components
        rv = mle(rv,ds);                 % Compute the ML estimate
        plotPdf(rv);                     % Plot the estimated PDF
        hold on;
        plot(ds);                        % Overlay the original data</pre></div><!--after help --><!--seeAlso--><div class="footerlinktitle">See also</div><div class="footerlink"> <a href="./prtRv.html">prtRv</a>, <a href="./prtRvMvn.html">prtRvMvn</a>, <a href="./prtRvMultinomial.html">prtRvMultinomial</a>, <a href="./prtRvUniform.html">prtRvUniform</a>,
              <a href="./prtRvUniformImproper.html">prtRvUniformImproper</a>, <a href="./prtRvVq.html">prtRvVq</a>
</div>
      <!--Class-->
      <div class="sectiontitle">Class Details</div>
      <table class="class-details">
         <tr>
            <td class="class-detail-label">Superclasses</td>
            <td><a href="./prtRv.html">prtRv</a></td>
         </tr>
         <tr>
            <td class="class-detail-label">Sealed</td>
            <td>false</td>
         </tr>
         <tr>
            <td class="class-detail-label">Construct on load</td>
            <td>false</td>
         </tr>
      </table>
      <!--Constructors-->
      <div class="sectiontitle"><a name="constructors"></a>Constructor Summary
      </div>
      <table class="summary-list">
         <tr class="summary-item">
            <td class="name"><a href="./prtRvGmm/prtRvGmm.html">prtRvGmm</a></td>
            <td class="m-help">Gaussian Mixture Model Random Variable&nbsp;</td>
         </tr>
      </table>
      <!--Properties-->
      <div class="sectiontitle"><a name="properties"></a>Property Summary
      </div>
      <table class="summary-list">
         <tr class="summary-item">
            <td class="name"><a href="./prtRvGmm/components.html">components</a></td>
            <td class="m-help">The mixture components&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtRvGmm/covariancePool.html">covariancePool</a></td>
            <td class="m-help">Flag indicating whether or not to pool the covariance&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtRvGmm/covarianceStructure.html">covarianceStructure</a></td>
            <td class="m-help">The covariance structure&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtRvGmm/dataSet.html">dataSet</a></td>
            <td class="m-help">The training prtDataSet, only stored if verboseStorage is true. &nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtRvGmm/dataSetSummary.html">dataSetSummary</a></td>
            <td class="m-help">Structure that summarizes prtDataSet.&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtRvGmm/isCrossValidateValid.html">isCrossValidateValid</a></td>
            <td class="m-help">&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtRvGmm/isSupervised.html">isSupervised</a></td>
            <td class="m-help">&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtRvGmm/isTrained.html">isTrained</a></td>
            <td class="m-help">Indicates if prtAction object has been trained.&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtRvGmm/mixingProportions.html">mixingProportions</a></td>
            <td class="m-help">The mixing proportions&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtRvGmm/nComponents.html">nComponents</a></td>
            <td class="m-help">The number of components&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtRvGmm/name.html">name</a></td>
            <td class="m-help">&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtRvGmm/nameAbbreviation.html">nameAbbreviation</a></td>
            <td class="m-help">&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtRvGmm/plotOptions.html">plotOptions</a></td>
            <td class="m-help">&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtRvGmm/showProgressBar.html">showProgressBar</a></td>
            <td class="m-help">&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtRvGmm/userData.html">userData</a></td>
            <td class="m-help">User specified data&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtRvGmm/verboseStorage.html">verboseStorage</a></td>
            <td class="m-help">Specifies whether or not to store the training prtDataset.&nbsp;</td>
         </tr>
      </table>
      <!--Methods-->
      <div class="sectiontitle"><a name="methods"></a>Method Summary
      </div>
      <table class="summary-list">
         <tr class="summary-item">
            <td class="attributes">
               &nbsp;
               
            </td>
            <td class="name"><a href="./prtRvGmm/cdf.html">cdf</a></td>
            <td class="m-help">Output the cdf of the random variable evaluated at the points specified&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="attributes">
               &nbsp;
               
            </td>
            <td class="name"><a href="./prtRvGmm/crossValidate.html">crossValidate</a></td>
            <td class="m-help">Cross validate prtAction using prtDataSet and cross validation keys.&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="attributes">
               &nbsp;
               
            </td>
            <td class="name"><a href="./prtRvGmm/draw.html">draw</a></td>
            <td class="m-help">Draw random samples from the distribution described by the prtRv object&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="attributes">
               &nbsp;
               
            </td>
            <td class="name"><a href="./prtRvGmm/get.html">get</a></td>
            <td class="m-help">get the object properties&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="attributes">
               &nbsp;
               
            </td>
            <td class="name"><a href="./prtRvGmm/kfolds.html">kfolds</a></td>
            <td class="m-help">Perform K-folds cross-validation of prtAction&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="attributes">
               &nbsp;
               
            </td>
            <td class="name"><a href="./prtRvGmm/logPdf.html">logPdf</a></td>
            <td class="m-help">Output the log pdf of the random variable evaluated at the points specified&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="attributes">
               &nbsp;
               
            </td>
            <td class="name"><a href="./prtRvGmm/mle.html">mle</a></td>
            <td class="m-help">Compute the maximum likelihood estimate &nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="attributes">
               &nbsp;
               
            </td>
            <td class="name"><a href="./prtRvGmm/optimize.html">optimize</a></td>
            <td class="m-help">Optimize action parameter by exhaustive function maximization.&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="attributes">
               &nbsp;
               
            </td>
            <td class="name"><a href="./prtRvGmm/pdf.html">pdf</a></td>
            <td class="m-help">Output the pdf of the random variable evaluated at the points specified&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="attributes">
               &nbsp;
               
            </td>
            <td class="name"><a href="./prtRvGmm/plotCdf.html">plotCdf</a></td>
            <td class="m-help">Plot the cdf of the prtRv&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="attributes">
               &nbsp;
               
            </td>
            <td class="name"><a href="./prtRvGmm/plotLogPdf.html">plotLogPdf</a></td>
            <td class="m-help">Plot the pdf of the prtRv&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="attributes">
               &nbsp;
               
            </td>
            <td class="name"><a href="./prtRvGmm/plotPdf.html">plotPdf</a></td>
            <td class="m-help">Plot the pdf of the prtRv&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="attributes">
               &nbsp;
               
            </td>
            <td class="name"><a href="./prtRvGmm/run.html">run</a></td>
            <td class="m-help">Run a prtAction object on a prtDataSet object.&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="attributes">
               &nbsp;
               
            </td>
            <td class="name"><a href="./prtRvGmm/set.html">set</a></td>
            <td class="m-help">set the object properties&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="attributes">
               &nbsp;
               
            </td>
            <td class="name"><a href="./prtRvGmm/train.html">train</a></td>
            <td class="m-help">Train a prtAction object using training a prtDataSet object.&nbsp;</td>
         </tr>
      </table>
   </body>
</html>